<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Unity ML-Agents Toolkit: RenderTextureSensorComponent Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygenbase.css" rel="stylesheet" type="text/css" />
<link href="unity.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Unity ML-Agents Toolkit
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">RenderTextureSensorComponent Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Component that wraps a <a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensor.html" title="Sensor class that wraps a RenderTexture instance.">RenderTextureSensor</a>.  
 <a href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html#details">More...</a></p>

<p>Inherits <a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent.html">SensorComponent</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af33001bb7f674c75660373e7694ab5ec"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="interfaceUnity_1_1MLAgents_1_1Sensors_1_1ISensor.html">ISensor</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html#af33001bb7f674c75660373e7694ab5ec">CreateSensor</a> ()</td></tr>
<tr class="memdesc:af33001bb7f674c75660373e7694ab5ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the <a class="el" href="interfaceUnity_1_1MLAgents_1_1Sensors_1_1ISensor.html" title="Sensor interface for generating observations.">ISensor</a>.This is called by the <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a> when it is initialized.  <a href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html#af33001bb7f674c75660373e7694ab5ec">More...</a><br /></td></tr>
<tr class="separator:af33001bb7f674c75660373e7694ab5ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d76391747ede7e0abbe3b7d7f4a73f4"><td class="memItemLeft" align="right" valign="top">override int[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html#a3d76391747ede7e0abbe3b7d7f4a73f4">GetObservationShape</a> ()</td></tr>
<tr class="memdesc:a3d76391747ede7e0abbe3b7d7f4a73f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the shape of the sensor observations that will be created.  <a href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html#a3d76391747ede7e0abbe3b7d7f4a73f4">More...</a><br /></td></tr>
<tr class="separator:a3d76391747ede7e0abbe3b7d7f4a73f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent.html">SensorComponent</a></td></tr>
<tr class="memitem:a9fcfcdf5ac3113dcc660dfb9a5c2e581 inherit pub_methods_classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent.html#a9fcfcdf5ac3113dcc660dfb9a5c2e581">IsVisual</a> ()</td></tr>
<tr class="memdesc:a9fcfcdf5ac3113dcc660dfb9a5c2e581 inherit pub_methods_classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the observation is visual or not.  <a href="classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent.html#a9fcfcdf5ac3113dcc660dfb9a5c2e581">More...</a><br /></td></tr>
<tr class="separator:a9fcfcdf5ac3113dcc660dfb9a5c2e581 inherit pub_methods_classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af41da8555b5d967ab1bf7d4981da0110 inherit pub_methods_classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent.html#af41da8555b5d967ab1bf7d4981da0110">IsVector</a> ()</td></tr>
<tr class="memdesc:af41da8555b5d967ab1bf7d4981da0110 inherit pub_methods_classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the observation is vector or not.  <a href="classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent.html#af41da8555b5d967ab1bf7d4981da0110">More...</a><br /></td></tr>
<tr class="separator:af41da8555b5d967ab1bf7d4981da0110 inherit pub_methods_classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a4ab3f6904f4045543f94ffe29522030b"><td class="memItemLeft" align="right" valign="top">RenderTexture&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html#a4ab3f6904f4045543f94ffe29522030b">RenderTexture</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a4ab3f6904f4045543f94ffe29522030b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the <a href="https://docs.unity3d.com/ScriptReference/RenderTexture.html">RenderTexture</a> associated with this sensor.  <a href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html#a4ab3f6904f4045543f94ffe29522030b">More...</a><br /></td></tr>
<tr class="separator:a4ab3f6904f4045543f94ffe29522030b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ea115196e377cab713107bc923e14aa"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html#a8ea115196e377cab713107bc923e14aa">SensorName</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a8ea115196e377cab713107bc923e14aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the generated <a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensor.html" title="Sensor class that wraps a RenderTexture instance.">RenderTextureSensor</a>.  <a href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html#a8ea115196e377cab713107bc923e14aa">More...</a><br /></td></tr>
<tr class="separator:a8ea115196e377cab713107bc923e14aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedf65820771b1ff993a331d205800d17"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html#aedf65820771b1ff993a331d205800d17">Grayscale</a><code> [get, set]</code></td></tr>
<tr class="memdesc:aedf65820771b1ff993a331d205800d17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the RenderTexture observation should be converted to grayscale or not.  <a href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html#aedf65820771b1ff993a331d205800d17">More...</a><br /></td></tr>
<tr class="separator:aedf65820771b1ff993a331d205800d17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bbeed17912e54578042b35577e7a816"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceUnity_1_1MLAgents_1_1Sensors.html#ad583e4111fa36e890e22d131c63f30f5">SensorCompressionType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html#a2bbeed17912e54578042b35577e7a816">CompressionType</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a2bbeed17912e54578042b35577e7a816"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compression type for the render texture observation.  <a href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html#a2bbeed17912e54578042b35577e7a816">More...</a><br /></td></tr>
<tr class="separator:a2bbeed17912e54578042b35577e7a816"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Component that wraps a <a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensor.html" title="Sensor class that wraps a RenderTexture instance.">RenderTextureSensor</a>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af33001bb7f674c75660373e7694ab5ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af33001bb7f674c75660373e7694ab5ec">&#9670;&nbsp;</a></span>CreateSensor()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">override <a class="el" href="interfaceUnity_1_1MLAgents_1_1Sensors_1_1ISensor.html">ISensor</a> CreateSensor </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create the <a class="el" href="interfaceUnity_1_1MLAgents_1_1Sensors_1_1ISensor.html" title="Sensor interface for generating observations.">ISensor</a>.This is called by the <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a> when it is initialized. </p>

<p>Implements <a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent.html#ae7a70aadeb77bfc40ec5d011b6e46939">SensorComponent</a>.</p>

</div>
</div>
<a id="a3d76391747ede7e0abbe3b7d7f4a73f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d76391747ede7e0abbe3b7d7f4a73f4">&#9670;&nbsp;</a></span>GetObservationShape()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">override int [] GetObservationShape </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the shape of the sensor observations that will be created. </p>

<p>Implements <a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1SensorComponent.html#a09a2b457d79bfe4088618f3f7e954a6c">SensorComponent</a>.</p>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a2bbeed17912e54578042b35577e7a816"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bbeed17912e54578042b35577e7a816">&#9670;&nbsp;</a></span>CompressionType</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceUnity_1_1MLAgents_1_1Sensors.html#ad583e4111fa36e890e22d131c63f30f5">SensorCompressionType</a> CompressionType</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Compression type for the render texture observation. </p>

</div>
</div>
<a id="aedf65820771b1ff993a331d205800d17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedf65820771b1ff993a331d205800d17">&#9670;&nbsp;</a></span>Grayscale</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool Grayscale</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Whether the RenderTexture observation should be converted to grayscale or not. </p>
<p>Note that changing this after the sensor is created has no effect.</p>

</div>
</div>
<a id="a4ab3f6904f4045543f94ffe29522030b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ab3f6904f4045543f94ffe29522030b">&#9670;&nbsp;</a></span>RenderTexture</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">RenderTexture RenderTexture</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Stores the <a href="https://docs.unity3d.com/ScriptReference/RenderTexture.html">RenderTexture</a> associated with this sensor. </p>

</div>
</div>
<a id="a8ea115196e377cab713107bc923e14aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ea115196e377cab713107bc923e14aa">&#9670;&nbsp;</a></span>SensorName</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string SensorName</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Name of the generated <a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensor.html" title="Sensor class that wraps a RenderTexture instance.">RenderTextureSensor</a>. </p>
<p>Note that changing this at runtime does not affect how the <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a> sorts the sensors.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="RenderTextureSensorComponent_8cs.html">RenderTextureSensorComponent.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceUnity.html">Unity</a></li><li class="navelem"><a class="el" href="namespaceUnity_1_1MLAgents.html">MLAgents</a></li><li class="navelem"><a class="el" href="namespaceUnity_1_1MLAgents_1_1Sensors.html">Sensors</a></li><li class="navelem"><a class="el" href="classUnity_1_1MLAgents_1_1Sensors_1_1RenderTextureSensorComponent.html">RenderTextureSensorComponent</a></li>
  </ul>
</div>
</body>
</html>
